<!DOCTYPE html>
<html lang="en">
<head>
    <meta name="viewport" content="width=device-width, initial-scale=1.0, maximum-scale=1.0, user-scalable=0"/>
    <meta charset="utf-8"/>
    <title>    OneLogin&#039;s SAML PHP Toolkit &raquo; \OneLogin_Saml2_Settings
</title>
    <meta name="author" content=""/>
    <meta name="description" content=""/>

            <link href="../css/template.css" rel="stylesheet" media="all"/>
    
            <!--[if lt IE 9]>
        <script src="http://html5shim.googlecode.com/svn/trunk/html5.js" type="text/javascript"></script>
        <![endif]-->
        <script src="../js/jquery-1.7.1.min.js" type="text/javascript"></script>
        <script src="../js/jquery-ui-1.8.2.custom.min.js" type="text/javascript"></script>
        <script src="../js/jquery.mousewheel.min.js" type="text/javascript"></script>
        <script src="../js/bootstrap.js" type="text/javascript"></script>
        <script src="../js/template.js" type="text/javascript"></script>
        <script src="../js/prettify/prettify.min.js" type="text/javascript"></script>
    
            <link rel="shortcut icon" href="../img/favicon.ico"/>
        <link rel="apple-touch-icon" href="../img/apple-touch-icon.png"/>
        <link rel="apple-touch-icon" sizes="72x72" href="../img/apple-touch-icon-72x72.png"/>
        <link rel="apple-touch-icon" sizes="114x114" href="../img/apple-touch-icon-114x114.png"/>
    </head>
<body>

        <div class="navbar navbar-fixed-top">
        <div class="navbar-inner">
            <div class="container">
                <a class="btn btn-navbar" data-toggle="collapse" data-target=".nav-collapse">
                    <span class="icon-bar"></span> <span class="icon-bar"></span>
                    <span class="icon-bar"></span> </a>
                <a class="brand" href="../index.html">OneLogin&#039;s SAML PHP Toolkit</a>

                <div class="nav-collapse">
                    <ul class="nav">
                        <li class="dropdown">
                            <a href="#api" class="dropdown-toggle" data-toggle="dropdown">
                                API Documentation <b class="caret"></b>
                            </a>
                            <ul class="dropdown-menu">
                                                                                            </ul>
                        </li>
                        <li class="dropdown" id="classes-menu">
                            <a href="../namespaces/default.html">Classes</a>
                        </li>                         
                        <li class="dropdown" id="charts-menu">
                            <a href="#charts" class="dropdown-toggle" data-toggle="dropdown">
                                Charts <b class="caret"></b>
                            </a>
                            <ul class="dropdown-menu">
                                <li>
                                    <a href="../graph_class.html">
                                        <i class="icon-list-alt"></i>&#160;Class hierarchy diagram
                                    </a>
                                </li>
                            </ul>
                        </li>
                    </ul>
                </div>
            </div>
        </div>
        <div class="go_to_top">
            <a href="#___" style="color: inherit">Back to top&#160;&#160;<i class="icon-upload icon-white"></i></a>
        </div>
    </div>
    
    <div id="___" class="container">
        <noscript>
            <div class="alert alert-warning">
                Javascript is disabled; several features are only available if Javascript is enabled.
            </div>
        </noscript>

        
            <style>
        .deprecated h2 {
            text-decoration: line-through;
        }
    </style>
    <div class="row">
        <div class="span4">
                    <div class="btn-group view pull-right" data-toggle="buttons-radio">
        <button class="btn details" title="Show descriptions and method names"><i class="icon-list"></i></button>
        <button class="btn simple" title="Show only method names"><i class="icon-align-justify"></i></button>
    </div>
    <div class="btn-group visibility" data-toggle="buttons-checkbox">
        <button class="btn public active" title="Show public elements">Public</button>
        <button class="btn protected" title="Show protected elements">Protected</button>
        <button class="btn private" title="Show private elements">Private</button>
        <button class="btn inherited active" title="Show inherited elements">Inherited</button>
    </div>

        <ul class="side-nav nav nav-list">
        <li class="nav-header">
            <i class="icon-custom icon-method"></i> Methods
            <ul>
                                                                                                    <li class="method public">
        <a href="#method___construct" title="__construct :: Initializes the settings:
- Sets the paths of the different folders
- Loads settings info from settings file or array/object provided">
            <span class="description">Initializes the settings:
- Sets the paths of the different folders
- Loads settings info from settings file or array/object provided</span><pre>__construct</pre>
        </a>
    </li>

                                                                                                                                                                <li class="method public">
        <a href="#method_getBasePath" title="getBasePath :: Returns base path.">
            <span class="description">Returns base path.</span><pre>getBasePath</pre>
        </a>
    </li>

                                                                                                        <li class="method public">
        <a href="#method_getCertPath" title="getCertPath :: Returns cert path.">
            <span class="description">Returns cert path.</span><pre>getCertPath</pre>
        </a>
    </li>



        <a href="#method_getConfigPath" title="getConfigPath :: Returns config path.">
            <span class="description">Returns config path.</span><pre>getConfigPath</pre>
        </a>
    </li>
                                                                                                        <li class="method public">
        <a href="#method_getLibPath" title="getLibPath :: Returns lib path.">
            <span class="description">Returns lib path.</span><pre>getLibPath</pre>
        </a>
    </li>

                                                                                                        <li class="method public">
        <a href="#method_getExtLibPath" title="getExtLibPath :: Returns external lib path.">
            <span class="description">Returns external lib path.</span><pre>getExtLibPath</pre>
        </a>
    </li>

                                                                                                        <li class="method public">
        <a href="#method_getSchemasPath" title="getSchemasPath :: Returns schema path.">
            <span class="description">Returns schema path.</span><pre>getSchemasPath</pre>
        </a>
    </li>

                                                                                                                                                                                                                                                                                <li class="method public">
        <a href="#method_checkSettings" title="checkSettings :: Checks the settings info.">
            <span class="description">Checks the settings info.</span><pre>checkSettings</pre>
        </a>
    </li>

                                                                                                        <li class="method public">
        <a href="#method_checkSPCerts" title="checkSPCerts :: Checks if the x509 certs of the SP exists and are valid.">
            <span class="description">Checks if the x509 certs of the SP exists and are valid.</span><pre>checkSPCerts</pre>
        </a>
    </li>

                                                                                                        <li class="method public">
        <a href="#method_getSPkey" title="getSPkey :: Returns the x509 private key of the SP.">
            <span class="description">Returns the x509 private key of the SP.</span><pre>getSPkey</pre>
        </a>
    </li>

                                                                                                        <li class="method public">
        <a href="#method_getSPcert" title="getSPcert :: Returns the x509 public cert of the SP.">
            <span class="description">Returns the x509 public cert of the SP.</span><pre>getSPcert</pre>
        </a>
    </li>

                                                                                                        <li class="method public">
        <a href="#method_getIdPData" title="getIdPData :: Gets the IdP data.">
            <span class="description">Gets the IdP data.</span><pre>getIdPData</pre>
        </a>
    </li>

                                                                                                        <li class="method public">
        <a href="#method_getSPData" title="getSPData :: Gets the SP data.">
            <span class="description">Gets the SP data.</span><pre>getSPData</pre>
        </a>
    </li>

                                                                                                        <li class="method public">
        <a href="#method_getSecurityData" title="getSecurityData :: Gets security data.">
            <span class="description">Gets security data.</span><pre>getSecurityData</pre>
        </a>
    </li>

                                                                                                        <li class="method public">
        <a href="#method_getContacts" title="getContacts :: Gets contact data.">
            <span class="description">Gets contact data.</span><pre>getContacts</pre>
        </a>
    </li>

                                                                                                        <li class="method public">
        <a href="#method_getOrganization" title="getOrganization :: Gets organization data.">
            <span class="description">Gets organization data.</span><pre>getOrganization</pre>
        </a>
    </li>

                                                                                                        <li class="method public">
        <a href="#method_getSPMetadata" title="getSPMetadata :: Gets the SP metadata. The XML representation.">
            <span class="description">Gets the SP metadata. The XML representation.</span><pre>getSPMetadata</pre>
        </a>
    </li>

                                                                                                        <li class="method public">
        <a href="#method_validateMetadata" title="validateMetadata :: Validates an XML SP Metadata.">
            <span class="description">Validates an XML SP Metadata.</span><pre>validateMetadata</pre>
        </a>
    </li>

                                                                                                        <li class="method public">
        <a href="#method_formatIdPCert" title="formatIdPCert :: Formats the IdP cert.">
            <span class="description">Formats the IdP cert.</span><pre>formatIdPCert</pre>
        </a>
    </li>

                                                                                                        <li class="method public">
        <a href="#method_formatSPPCert" title="formatSPCert :: Formats the SP cert.">
            <span class="description">Formats the SP cert.</span><pre>formatSPCert</pre>
        </a>
    </li>

                                                                                                        <li class="method public">
        <a href="#method_formatSPKey" title="formatSPKey :: Formats the SP cert.">
            <span class="description">Formats the SP private key.</span><pre>formatSPKey</pre>
        </a>
    </li>

                                                                                                        <li class="method public">
        <a href="#method_getErrors" title="getErrors :: Returns an array with the errors, the array is empty when the settings is ok.">
            <span class="description">Returns an array with the errors, the array is empty when the settings is ok.</span><pre>getErrors</pre>
        </a>
    </li>

                                                                                                        <li class="method public">
        <a href="#method_setStrict" title="setStrict :: Activates or deactivates the strict mode.">
            <span class="description">Activates or deactivates the strict mode.</span><pre>setStrict</pre>
        </a>
    </li>

                                                                                                        <li class="method public">
        <a href="#method_isStrict" title="isStrict :: Returns if the &#039;strict&#039; mode is active.">
            <span class="description">Returns if the &#039;strict&#039; mode is active.</span><pre>isStrict</pre>
        </a>
    </li>

                                                                                                        <li class="method public">
        <a href="#method_isDebugActive" title="isDebugActive :: Returns if the debug is active.">
            <span class="description">Returns if the debug is active.</span><pre>isDebugActive</pre>
        </a>
    </li>

                                                </ul>
        </li>
        <li class="nav-header protected">» Protected
            <ul>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    </ul>
        </li>
        <li class="nav-header private">» Private
            <ul>
                                                                                                                <li class="method private">
                            <a href="#method__loadPaths" title="_loadPaths :: Sets the paths of the different folders">
                                <span class="description">Sets the paths of the different folders</span><pre>_loadPaths</pre>
                            </a>
                        </li>
                                                                                                                                                                                                                                                                    <li class="method private">
                            <a href="#method__loadSettingsFromArray" title="_loadSettingsFromArray :: Loads settings info from a settings Array">
                                <span class="description">Loads settings info from a settings Array</span><pre>_loadSettingsFromArray</pre>
                            </a>
                        </li>
                                                                                <li class="method private">
                            <a href="#method__loadSettingsFromFile" title="_loadSettingsFromFile :: Loads settings info from the settings file">
                                <span class="description">Loads settings info from the settings file</span><pre>_loadSettingsFromFile</pre>
                            </a>
                        </li>
                                                                                <li class="method private">
                            <a href="#method__addDefaultValues" title="_addDefaultValues :: Add default values if the settings info is not complete">
                                <span class="description">Add default values if the settings info is not complete</span><pre>_addDefaultValues</pre>
                            </a>
                        </li>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                </ul>
        </li>
        <li class="nav-header">
            <i class="icon-custom icon-constant"></i> Constants
            <ul>
                            </ul>
        </li>
    </ul>


        </div>

        <div class="span8">
            <div class="element class">
                <h1>OneLogin_Saml2_Settings</h1>
                <small style="display: block; text-align: right">
                                                        </small>
                <p class="short_description">Configuration of the OneLogin PHP Toolkit</p>
                <div class="details">
                    <div class="long_description">
                        
                    </div>
                    <table class="table table-bordered">
                                                                                                                                                                                                                                                            </table>

                    <h3><i class="icon-custom icon-method"></i> Methods</h3>
                                                                <a id="method___construct"></a>
                        <div class="element clickable method public  method___construct" data-toggle="collapse" data-target=".method___construct .collapse">
                            <h2>Initializes the settings:
- Sets the paths of the different folders
- Loads settings info from settings file or array/object provided</h2>
                            <pre>__construct(array|object $settings = null) </pre>
                            <div class="labels">
                                                                                                                                                                                            </div>
                            <div class="row collapse">
                                <div class="detail-description">
                                    <div class="long_description"></div>

                                    <table class="table">
                                                                                    <tr>
                                                <th>
                                                    exceptions
                                                </th>
                                                <td>
                                                                                                                                                                        
                                                                                                                                                                        <p>Throws error exception if any settings parameter is invalid</p>
                                                                                                    </td>
                                            </tr>
                                                                                    <tr>
                                                <th>
                                                    
                                                </th>
                                                <td>
                                                                                                    </td>
                                            </tr>
                                                                                    <tr>
                                                <th>
                                                    
                                                </th>
                                                <td>
                                                                                                    </td>
                                            </tr>
                                                                            </table>

                                                                            <h3>Arguments</h3>
                                                                                    <div class="subelement argument">
                                                <h4>$settings</h4>
                                                <code>array|object</code><p><p>SAML Toolkit Settings</p></p>
                                            </div>
                                                                            
                                                                    </div>
                            </div>
                        </div>
                                            <a id="method__loadPaths"></a>
                        <div class="element clickable method private  method__loadPaths" data-toggle="collapse" data-target=".method__loadPaths .collapse">
                            <h2>Sets the paths of the different folders</h2>
                            <pre>_loadPaths() </pre>
                            <div class="labels">
                                                                                                                                                                                            </div>
                            <div class="row collapse">
                                <div class="detail-description">
                                    <div class="long_description"></div>

                                    <table class="table">
                                                                                    <tr>
                                                <th>
                                                    
                                                </th>
                                                <td>
                                                                                                    </td>
                                            </tr>
                                                                                    <tr>
                                                <th>
                                                    
                                                </th>
                                                <td>
                                                                                                    </td>
                                            </tr>
                                                                                    <tr>
                                                <th>
                                                    
                                                </th>
                                                <td>
                                                                                                    </td>
                                            </tr>
                                                                            </table>

                                    
                                                                    </div>
                            </div>
                        </div>
                                            <a id="method_getBasePath"></a>
                        <div class="element clickable method public  method_getBasePath" data-toggle="collapse" data-target=".method_getBasePath .collapse">
                            <h2>Returns base path.</h2>
                            <pre>getBasePath() : string</pre>
                            <div class="labels">
                                                                                                                                                                                            </div>
                            <div class="row collapse">
                                <div class="detail-description">
                                    <div class="long_description"></div>

                                    <table class="table">
                                                                                    <tr>
                                                <th>
                                                    
                                                </th>
                                                <td>
                                                                                                    </td>
                                            </tr>
                                                                                    <tr>
                                                <th>
                                                    
                                                </th>
                                                <td>
                                                                                                    </td>
                                            </tr>
                                                                            </table>

                                    
                                                                            <h3>Response</h3>
                                        <code>string</code><p><p>The base toolkit folder path</p></p>
                                                                    </div>
                            </div>
                        </div>
                                            <a id="method_getCertPath"></a>
                        <div class="element clickable method public  method_getCertPath" data-toggle="collapse" data-target=".method_getCertPath .collapse">
                            <h2>Returns cert path.</h2>
                            <pre>getCertPath() : string</pre>
                            <div class="labels">
                                                                                                                                                                                            </div>
                            <div class="row collapse">
                                <div class="detail-description">
                                    <div class="long_description"></div>

                                    <table class="table">
                                                                                    <tr>
                                                <th>
                                                    
                                                </th>
                                                <td>
                                                                                                    </td>
                                            </tr>
                                                                                    <tr>
                                                <th>
                                                    
                                                </th>
                                                <td>
                                                                                                    </td>
                                            </tr>
                                                                            </table>

                                    
                                                                            <h3>Response</h3>
                                        <code>string</code><p><p>The cert folder path</p></p>
                                                                    </div>
                            </div>
                        </div>

                        </div>
                                            <a id="method_getConfigPath"></a>
                <div class="element clickable method public  method_getConfigPath" data-toggle="collapse" data-target=".method_getConfigPath .collapse">
                            <h2>Returns config path.</h2>
                            <pre>getConfigPath() : string</pre>
                            <div class="labels">
                                                                                                                                                                                            </div>
                            <div class="row collapse">
                                <div class="detail-description">
                                    <div class="long_description"></div>

                                    <table class="table">
                                                                                    <tr>
                                                <th>
                                                    
                                                </th>
                                                <td>
                                                                                                    </td>
                                            </tr>
                                                                                    <tr>
                                                <th>
                                                    
                                                </th>
                                                <td>
                                                                                                    </td>
                                            </tr>
                                                                            </table>

                                    
                                                                            <h3>Response</h3>
                                        <code>string</code><p><p>The config folder path</p></p>
                                                                    </div>
                            </div>
                        </div>

                                            <a id="method_getLibPath"></a>
                        <div class="element clickable method public  method_getLibPath" data-toggle="collapse" data-target=".method_getLibPath .collapse">
                            <h2>Returns lib path.</h2>
                            <pre>getLibPath() : string</pre>
                            <div class="labels">
                                                                                                                                                                                            </div>
                            <div class="row collapse">
                                <div class="detail-description">
                                    <div class="long_description"></div>

                                    <table class="table">
                                                                                    <tr>
                                                <th>
                                                    
                                                </th>
                                                <td>
                                                                                                    </td>
                                            </tr>
                                                                                    <tr>
                                                <th>
                                                    
                                                </th>
                                                <td>
                                                                                                    </td>
                                            </tr>
                                                                            </table>

                                    
                                                                            <h3>Response</h3>
                                        <code>string</code><p><p>The library folder path</p></p>
                                                                    </div>
                            </div>
                        </div>
                                            <a id="method_getExtLibPath"></a>
                        <div class="element clickable method public  method_getExtLibPath" data-toggle="collapse" data-target=".method_getExtLibPath .collapse">
                            <h2>Returns external lib path.</h2>
                            <pre>getExtLibPath() : string</pre>
                            <div class="labels">
                                                                                                                                                                                            </div>
                            <div class="row collapse">
                                <div class="detail-description">
                                    <div class="long_description"></div>

                                    <table class="table">
                                                                                    <tr>
                                                <th>
                                                    
                                                </th>
                                                <td>
                                                                                                    </td>
                                            </tr>
                                                                                    <tr>
                                                <th>
                                                    
                                                </th>
                                                <td>
                                                                                                    </td>
                                            </tr>
                                                                            </table>

                                    
                                                                            <h3>Response</h3>
                                        <code>string</code><p><p>The external library folder path</p></p>
                                                                    </div>
                            </div>
                        </div>
                                            <a id="method_getSchemasPath"></a>
                        <div class="element clickable method public  method_getSchemasPath" data-toggle="collapse" data-target=".method_getSchemasPath .collapse">
                            <h2>Returns schema path.</h2>
                            <pre>getSchemasPath() : string</pre>
                            <div class="labels">
                                                                                                                                                                                            </div>
                            <div class="row collapse">
                                <div class="detail-description">
                                    <div class="long_description"></div>

                                    <table class="table">
                                                                                    <tr>
                                                <th>
                                                    
                                                </th>
                                                <td>
                                                                                                    </td>
                                            </tr>
                                                                                    <tr>
                                                <th>
                                                    
                                                </th>
                                                <td>
                                                                                                    </td>
                                            </tr>
                                                                            </table>

                                    
                                                                            <h3>Response</h3>
                                        <code>string</code><p><p>The external library folder path</p></p>
                                                                    </div>
                            </div>
                        </div>
                                            <a id="method__loadSettingsFromArray"></a>
                        <div class="element clickable method private  method__loadSettingsFromArray" data-toggle="collapse" data-target=".method__loadSettingsFromArray .collapse">
                            <h2>Loads settings info from a settings Array</h2>
                            <pre>_loadSettingsFromArray(array $settings) : boolean</pre>
                            <div class="labels">
                                                                                                                                                                                            </div>
                            <div class="row collapse">
                                <div class="detail-description">
                                    <div class="long_description"></div>

                                    <table class="table">
                                                                                    <tr>
                                                <th>
                                                    
                                                </th>
                                                <td>
                                                                                                    </td>
                                            </tr>
                                                                            </table>

                                                                            <h3>Arguments</h3>
                                                                                    <div class="subelement argument">
                                                <h4>$settings</h4>
                                                <code>array</code><p><p>SAML Toolkit Settings</p></p>
                                            </div>
                                                                            
                                                                            <h3>Response</h3>
                                        <code>boolean</code><p><p>True if the settings info is valid</p></p>
                                                                    </div>
                            </div>
                        </div>
                                            <a id="method__loadSettingsFromFile"></a>
                        <div class="element clickable method private  method__loadSettingsFromFile" data-toggle="collapse" data-target=".method__loadSettingsFromFile .collapse">
                            <h2>Loads settings info from the settings file</h2>
                            <pre>_loadSettingsFromFile() : boolean</pre>
                            <div class="labels">
                                                                                                                                                                                            </div>
                            <div class="row collapse">
                                <div class="detail-description">
                                    <div class="long_description"></div>

                                    <table class="table">
                                                                                    <tr>
                                                <th>
                                                    
                                                </th>
                                                <td>
                                                                                                    </td>
                                            </tr>
                                                                                    <tr>
                                                <th>
                                                    
                                                </th>
                                                <td>
                                                                                                    </td>
                                            </tr>
                                                                            </table>

                                    
                                                                            <h3>Response</h3>
                                        <code>boolean</code><p><p>True if the settings info is valid</p></p>
                                                                    </div>
                            </div>
                        </div>
                                            <a id="method__addDefaultValues"></a>
                        <div class="element clickable method private  method__addDefaultValues" data-toggle="collapse" data-target=".method__addDefaultValues .collapse">
                            <h2>Add default values if the settings info is not complete</h2>
                            <pre>_addDefaultValues() </pre>
                            <div class="labels">
                                                                                                                                                                                            </div>
                            <div class="row collapse">
                                <div class="detail-description">
                                    <div class="long_description"></div>

                                    <table class="table">
                                                                                    <tr>
                                                <th>
                                                    
                                                </th>
                                                <td>
                                                                                                    </td>
                                            </tr>
                                                                                    <tr>
                                                <th>
                                                    
                                                </th>
                                                <td>
                                                                                                    </td>
                                            </tr>
                                                                                    <tr>
                                                <th>
                                                    
                                                </th>
                                                <td>
                                                                                                    </td>
                                            </tr>
                                                                            </table>

                                    
                                                                    </div>
                            </div>
                        </div>
                                            <a id="method_checkSettings"></a>
                        <div class="element clickable method public  method_checkSettings" data-toggle="collapse" data-target=".method_checkSettings .collapse">
                            <h2>Checks the settings info.</h2>
                            <pre>checkSettings(array $settings) : array</pre>
                            <div class="labels">
                                                                                                                                                                                            </div>
                            <div class="row collapse">
                                <div class="detail-description">
                                    <div class="long_description"></div>

                                    <table class="table">
                                                                                    <tr>
                                                <th>
                                                    
                                                </th>
                                                <td>
                                                                                                    </td>
                                            </tr>
                                                                            </table>

                                                                            <h3>Arguments</h3>
                                                                                    <div class="subelement argument">
                                                <h4>$settings</h4>
                                                <code>array</code><p><p>Array with settings data</p></p>
                                            </div>
                                                                            
                                                                            <h3>Response</h3>
                                        <code>array</code><p><p>$errors  Errors found on the settings data</p></p>
                                                                    </div>
                            </div>
                        </div>
                                            <a id="method_checkSPCerts"></a>
                        <div class="element clickable method public  method_checkSPCerts" data-toggle="collapse" data-target=".method_checkSPCerts .collapse">
                            <h2>Checks if the x509 certs of the SP exists and are valid.</h2>
                            <pre>checkSPCerts() : boolean</pre>
                            <div class="labels">
                                                                                                                                                                                            </div>
                            <div class="row collapse">
                                <div class="detail-description">
                                    <div class="long_description"></div>

                                    <table class="table">
                                                                                    <tr>
                                                <th>
                                                    
                                                </th>
                                                <td>
                                                                                                    </td>
                                            </tr>
                                                                                    <tr>
                                                <th>
                                                    
                                                </th>
                                                <td>
                                                                                                    </td>
                                            </tr>
                                                                            </table>

                                    
                                                                            <h3>Response</h3>
                                        <code>boolean</code><p></p>
                                                                    </div>
                            </div>
                        </div>
                                            <a id="method_getSPkey"></a>
                        <div class="element clickable method public  method_getSPkey" data-toggle="collapse" data-target=".method_getSPkey .collapse">
                            <h2>Returns the x509 private key of the SP.</h2>
                            <pre>getSPkey() : string</pre>
                            <div class="labels">
                                                                                                                                                                                            </div>
                            <div class="row collapse">
                                <div class="detail-description">
                                    <div class="long_description"></div>

                                    <table class="table">
                                                                                    <tr>
                                                <th>
                                                    
                                                </th>
                                                <td>
                                                                                                    </td>
                                            </tr>
                                                                                    <tr>
                                                <th>
                                                    
                                                </th>
                                                <td>
                                                                                                    </td>
                                            </tr>
                                                                            </table>

                                    
                                                                            <h3>Response</h3>
                                        <code>string</code><p><p>SP private key</p></p>
                                                                    </div>
                            </div>
                        </div>
                                            <a id="method_getSPcert"></a>
                        <div class="element clickable method public  method_getSPcert" data-toggle="collapse" data-target=".method_getSPcert .collapse">
                            <h2>Returns the x509 public cert of the SP.</h2>
                            <pre>getSPcert() : string</pre>
                            <div class="labels">
                                                                                                                                                                                            </div>
                            <div class="row collapse">
                                <div class="detail-description">
                                    <div class="long_description"></div>

                                    <table class="table">
                                                                                    <tr>
                                                <th>
                                                    
                                                </th>
                                                <td>
                                                                                                    </td>
                                            </tr>
                                                                                    <tr>
                                                <th>
                                                    
                                                </th>
                                                <td>
                                                                                                    </td>
                                            </tr>
                                                                            </table>

                                    
                                                                            <h3>Response</h3>
                                        <code>string</code><p><p>SP public cert</p></p>
                                                                    </div>
                            </div>
                        </div>
                                            <a id="method_getIdPData"></a>
                        <div class="element clickable method public  method_getIdPData" data-toggle="collapse" data-target=".method_getIdPData .collapse">
                            <h2>Gets the IdP data.</h2>
                            <pre>getIdPData() : array</pre>
                            <div class="labels">
                                                                                                                                                                                            </div>
                            <div class="row collapse">
                                <div class="detail-description">
                                    <div class="long_description"></div>

                                    <table class="table">
                                                                                    <tr>
                                                <th>
                                                    
                                                </th>
                                                <td>
                                                                                                    </td>
                                            </tr>
                                                                                    <tr>
                                                <th>
                                                    
                                                </th>
                                                <td>
                                                                                                    </td>
                                            </tr>
                                                                            </table>

                                    
                                                                            <h3>Response</h3>
                                        <code>array</code><p><p>IdP info</p></p>
                                                                    </div>
                            </div>
                        </div>
                                            <a id="method_getSPData"></a>
                        <div class="element clickable method public  method_getSPData" data-toggle="collapse" data-target=".method_getSPData .collapse">
                            <h2>Gets the SP data.</h2>
                            <pre>getSPData() : array</pre>
                            <div class="labels">
                                                                                                                                                                                            </div>
                            <div class="row collapse">
                                <div class="detail-description">
                                    <div class="long_description"></div>

                                    <table class="table">
                                                                                    <tr>
                                                <th>
                                                    
                                                </th>
                                                <td>
                                                                                                    </td>
                                            </tr>
                                                                                    <tr>
                                                <th>
                                                    
                                                </th>
                                                <td>
                                                                                                    </td>
                                            </tr>
                                                                            </table>

                                    
                                                                            <h3>Response</h3>
                                        <code>array</code><p><p>SP info</p></p>
                                                                    </div>
                            </div>
                        </div>
                                            <a id="method_getSecurityData"></a>
                        <div class="element clickable method public  method_getSecurityData" data-toggle="collapse" data-target=".method_getSecurityData .collapse">
                            <h2>Gets security data.</h2>
                            <pre>getSecurityData() : array</pre>
                            <div class="labels">
                                                                                                                                                                                            </div>
                            <div class="row collapse">
                                <div class="detail-description">
                                    <div class="long_description"></div>

                                    <table class="table">
                                                                                    <tr>
                                                <th>
                                                    
                                                </th>
                                                <td>
                                                                                                    </td>
                                            </tr>
                                                                                    <tr>
                                                <th>
                                                    
                                                </th>
                                                <td>
                                                                                                    </td>
                                            </tr>
                                                                            </table>

                                    
                                                                            <h3>Response</h3>
                                        <code>array</code><p><p>SP info</p></p>
                                                                    </div>
                            </div>
                        </div>
                                            <a id="method_getContacts"></a>
                        <div class="element clickable method public  method_getContacts" data-toggle="collapse" data-target=".method_getContacts .collapse">
                            <h2>Gets contact data.</h2>
                            <pre>getContacts() : array</pre>
                            <div class="labels">
                                                                                                                                                                                            </div>
                            <div class="row collapse">
                                <div class="detail-description">
                                    <div class="long_description"></div>

                                    <table class="table">
                                                                                    <tr>
                                                <th>
                                                    
                                                </th>
                                                <td>
                                                                                                    </td>
                                            </tr>
                                                                                    <tr>
                                                <th>
                                                    
                                                </th>
                                                <td>
                                                                                                    </td>
                                            </tr>
                                                                            </table>

                                    
                                                                            <h3>Response</h3>
                                        <code>array</code><p><p>SP info</p></p>
                                                                    </div>
                            </div>
                        </div>
                                            <a id="method_getOrganization"></a>
                        <div class="element clickable method public  method_getOrganization" data-toggle="collapse" data-target=".method_getOrganization .collapse">
                            <h2>Gets organization data.</h2>
                            <pre>getOrganization() : array</pre>
                            <div class="labels">
                                                                                                                                                                                            </div>
                            <div class="row collapse">
                                <div class="detail-description">
                                    <div class="long_description"></div>

                                    <table class="table">
                                                                                    <tr>
                                                <th>
                                                    
                                                </th>
                                                <td>
                                                                                                    </td>
                                            </tr>
                                                                                    <tr>
                                                <th>
                                                    
                                                </th>
                                                <td>
                                                                                                    </td>
                                            </tr>
                                                                            </table>

                                    
                                                                            <h3>Response</h3>
                                        <code>array</code><p><p>SP info</p></p>
                                                                    </div>
                            </div>
                        </div>
                                            <a id="method_getSPMetadata"></a>
                        <div class="element clickable method public  method_getSPMetadata" data-toggle="collapse" data-target=".method_getSPMetadata .collapse">
                            <h2>Gets the SP metadata. The XML representation.</h2>
                            <pre>getSPMetadata() : string</pre>
                            <div class="labels">
                                                                                                                                                                                            </div>
                            <div class="row collapse">
                                <div class="detail-description">
                                    <div class="long_description"></div>

                                    <table class="table">
                                                                                    <tr>
                                                <th>
                                                    
                                                </th>
                                                <td>
                                                                                                    </td>
                                            </tr>
                                                                                    <tr>
                                                <th>
                                                    
                                                </th>
                                                <td>
                                                                                                    </td>
                                            </tr>
                                                                            </table>

                                    
                                                                            <h3>Response</h3>
                                        <code>string</code><p><p>SP metadata (xml)</p></p>
                                                                    </div>
                            </div>
                        </div>
                                            <a id="method_validateMetadata"></a>
                        <div class="element clickable method public  method_validateMetadata" data-toggle="collapse" data-target=".method_validateMetadata .collapse">
                            <h2>Validates an XML SP Metadata.</h2>
                            <pre>validateMetadata(string $xml) : Array</pre>
                            <div class="labels">
                                                                                                                                                                                            </div>
                            <div class="row collapse">
                                <div class="detail-description">
                                    <div class="long_description"></div>

                                    <table class="table">
                                                                                    <tr>
                                                <th>
                                                    
                                                </th>
                                                <td>
                                                                                                    </td>
                                            </tr>
                                                                            </table>

                                                                            <h3>Arguments</h3>
                                                                                    <div class="subelement argument">
                                                <h4>$xml</h4>
                                                <code>string</code><p><p>Metadata's XML that will be validate</p></p>
                                            </div>
                                                                            
                                                                            <h3>Response</h3>
                                        <code>Array</code><p><p>The list of found errors</p></p>
                                                                    </div>
                            </div>
                        </div>
                                            <a id="method_formatIdPCert"></a>
                        <div class="element clickable method public  method_formatIdPCert" data-toggle="collapse" data-target=".method_formatIdPCert .collapse">
                            <h2>Formats the IdP cert.</h2>
                            <pre>formatIdPCert() </pre>
                            <div class="labels">
                                                                                                                                                                                            </div>
                            <div class="row collapse">
                                <div class="detail-description">
                                    <div class="long_description"></div>

                                    <table class="table">
                                                                                    <tr>
                                                <th>
                                                    
                                                </th>
                                                <td>
                                                                                                    </td>
                                            </tr>
                                                                                    <tr>
                                                <th>
                                                    
                                                </th>
                                                <td>
                                                                                                    </td>
                                            </tr>
                                                                                    <tr>
                                                <th>
                                                    
                                                </th>
                                                <td>
                                                                                                    </td>
                                            </tr>
                                                                            </table>

                                    
                                                                    </div>
                            </div>
                        </div>

                    <a id="method_formatSPKey"></a>
                        <div class="element clickable method public  method_formatSPKey" data-toggle="collapse" data-target=".method_formatSPKey .collapse">
                            <h2>Formats the SP private key.</h2>
                            <pre>formatSPKey() </pre>
                            <div class="labels">
                                                                                                                                                                                            </div>
                            <div class="row collapse">
                                <div class="detail-description">
                                    <div class="long_description"></div>

                                    <table class="table">
                                                                                    <tr>
                                                <th>
                                                    
                                                </th>
                                                <td>
                                                                                                    </td>
                                            </tr>
                                                                                    <tr>
                                                <th>
                                                    
                                                </th>
                                                <td>
                                                                                                    </td>
                                            </tr>
                                                                                    <tr>
                                                <th>
                                                    
                                                </th>
                                                <td>
                                                                                                    </td>
                                            </tr>
                                                                            </table>

                                    
                                                                    </div>
                            </div>
                        </div>

                                           <a id="method_formatIdPCert"></a>
                        <div class="element clickable method public  method_formatSPCert" data-toggle="collapse" data-target=".method_formatSPCert .collapse">
                            <h2>Formats the SP cert.</h2>
                            <pre>formatSPCert() </pre>
                            <div class="labels">
                                                                                                                                                                                            </div>
                            <div class="row collapse">
                                <div class="detail-description">
                                    <div class="long_description"></div>

                                    <table class="table">
                                                                                    <tr>
                                                <th>
                                                    
                                                </th>
                                                <td>
                                                                                                    </td>
                                            </tr>
                                                                                    <tr>
                                                <th>
                                                    
                                                </th>
                                                <td>
                                                                                                    </td>
                                            </tr>
                                                                                    <tr>
                                                <th>
                                                    
                                                </th>
                                                <td>
                                                                                                    </td>
                                            </tr>
                                                                            </table>
                                    
                                                                    </div>
                            </div>
                        </div>                        
                                            <a id="method_getErrors"></a>
                        <div class="element clickable method public  method_getErrors" data-toggle="collapse" data-target=".method_getErrors .collapse">
                            <h2>Returns an array with the errors, the array is empty when the settings is ok.</h2>
                            <pre>getErrors() : array</pre>
                            <div class="labels">
                                                                                                                                                                                            </div>
                            <div class="row collapse">
                                <div class="detail-description">
                                    <div class="long_description"></div>

                                    <table class="table">
                                                                                    <tr>
                                                <th>
                                                    
                                                </th>
                                                <td>
                                                                                                    </td>
                                            </tr>
                                                                                    <tr>
                                                <th>
                                                    
                                                </th>
                                                <td>
                                                                                                    </td>
                                            </tr>
                                                                            </table>

                                    
                                                                            <h3>Response</h3>
                                        <code>array</code><p><p>Errors</p></p>
                                                                    </div>
                            </div>
                        </div>
                                            <a id="method_setStrict"></a>
                        <div class="element clickable method public  method_setStrict" data-toggle="collapse" data-target=".method_setStrict .collapse">
                            <h2>Activates or deactivates the strict mode.</h2>
                            <pre>setStrict(boolean $value) </pre>
                            <div class="labels">
                                                                                                                                                                                            </div>
                            <div class="row collapse">
                                <div class="detail-description">
                                    <div class="long_description"></div>

                                    <table class="table">
                                                                                    <tr>
                                                <th>
                                                    
                                                </th>
                                                <td>
                                                                                                    </td>
                                            </tr>
                                                                                    <tr>
                                                <th>
                                                    
                                                </th>
                                                <td>
                                                                                                    </td>
                                            </tr>
                                                                            </table>

                                                                            <h3>Arguments</h3>
                                                                                    <div class="subelement argument">
                                                <h4>$value</h4>
                                                <code>boolean</code><p><p>Strict parameter</p></p>
                                            </div>
                                                                            
                                                                    </div>
                            </div>
                        </div>
                                            <a id="method_isStrict"></a>
                        <div class="element clickable method public  method_isStrict" data-toggle="collapse" data-target=".method_isStrict .collapse">
                            <h2>Returns if the &#039;strict&#039; mode is active.</h2>
                            <pre>isStrict() : boolean</pre>
                            <div class="labels">
                                                                                                                                                                                            </div>
                            <div class="row collapse">
                                <div class="detail-description">
                                    <div class="long_description"></div>

                                    <table class="table">
                                                                                    <tr>
                                                <th>
                                                    
                                                </th>
                                                <td>
                                                                                                    </td>
                                            </tr>
                                                                                    <tr>
                                                <th>
                                                    
                                                </th>
                                                <td>
                                                                                                    </td>
                                            </tr>
                                                                            </table>

                                    
                                                                            <h3>Response</h3>
                                        <code>boolean</code><p><p>Strict parameter</p></p>
                                                                    </div>
                            </div>
                        </div>
                                            <a id="method_isDebugActive"></a>
                        <div class="element clickable method public  method_isDebugActive" data-toggle="collapse" data-target=".method_isDebugActive .collapse">
                            <h2>Returns if the debug is active.</h2>
                            <pre>isDebugActive() : boolean</pre>
                            <div class="labels">
                                                                                                                                                                                            </div>
                            <div class="row collapse">
                                <div class="detail-description">
                                    <div class="long_description"></div>

                                    <table class="table">
                                                                                    <tr>
                                                <th>
                                                    
                                                </th>
                                                <td>
                                                                                                    </td>
                                            </tr>
                                                                                    <tr>
                                                <th>
                                                    
                                                </th>
                                                <td>
                                                                                                    </td>
                                            </tr>
                                                                            </table>

                                    
                                                                            <h3>Response</h3>
                                        <code>boolean</code><p><p>Debug parameter</p></p>
                                                                    </div>
                            </div>
                        </div>
                    
                    
                                                                <h3><i class="icon-custom icon-property"></i> Properties</h3>
                                                    <a id="property__paths"> </a>
                            <div class="element clickable property  private property__paths" data-toggle="collapse" data-target=".property__paths .collapse">
                                <h2>List of paths.</h2>
                                <pre>_paths : array</pre>
                                <div class="labels">
                                                                                                        </div>
                                <div class="row collapse">
                                    <div class="detail-description">
                                        <div class="long_description"></div>

                                        <table class="table">
                                                                                            <tr>
                                                    <th>
                                                        var
                                                    </th>
                                                    <td>
                                                                                                                    
                                                                                                            </td>
                                                </tr>
                                                                                            <tr>
                                                    <th>
                                                        
                                                    </th>
                                                    <td>
                                                                                                            </td>
                                                </tr>
                                                                                    </table>

                                                                                    <h3>Type(s)</h3>
                                            <code>array</code>
                                                                            </div>
                                </div>
                            </div>
                                                    <a id="property__strict"> </a>
                            <div class="element clickable property  private property__strict" data-toggle="collapse" data-target=".property__strict .collapse">
                                <h2>Strict. If active, PHP Toolkit will reject unsigned or unencrypted messages
if it expects them signed or encrypted. If not, the messages will be accepted
and some security issues will be also relaxed.</h2>
                                <pre>_strict : boolean</pre>
                                <div class="labels">
                                                                                                        </div>
                                <div class="row collapse">
                                    <div class="detail-description">
                                        <div class="long_description"></div>

                                        <table class="table">
                                                                                            <tr>
                                                    <th>
                                                        var
                                                    </th>
                                                    <td>
                                                                                                                    
                                                                                                            </td>
                                                </tr>
                                                                                            <tr>
                                                    <th>
                                                        
                                                    </th>
                                                    <td>
                                                                                                            </td>
                                                </tr>
                                                                                    </table>

                                                                                    <h3>Type(s)</h3>
                                            <code>boolean</code>
                                                                            </div>
                                </div>
                            </div>
                                                    <a id="property__debug"> </a>
                            <div class="element clickable property  private property__debug" data-toggle="collapse" data-target=".property__debug .collapse">
                                <h2>Activate debug mode</h2>
                                <pre>_debug : boolean</pre>
                                <div class="labels">
                                                                                                        </div>
                                <div class="row collapse">
                                    <div class="detail-description">
                                        <div class="long_description"></div>

                                        <table class="table">
                                                                                            <tr>
                                                    <th>
                                                        var
                                                    </th>
                                                    <td>
                                                                                                                    
                                                                                                            </td>
                                                </tr>
                                                                                            <tr>
                                                    <th>
                                                        
                                                    </th>
                                                    <td>
                                                                                                            </td>
                                                </tr>
                                                                                    </table>

                                                                                    <h3>Type(s)</h3>
                                            <code>boolean</code>
                                                                            </div>
                                </div>
                            </div>
                                                    <a id="property__sp"> </a>
                            <div class="element clickable property  private property__sp" data-toggle="collapse" data-target=".property__sp .collapse">
                                <h2>SP data.</h2>
                                <pre>_sp : array</pre>
                                <div class="labels">
                                                                                                        </div>
                                <div class="row collapse">
                                    <div class="detail-description">
                                        <div class="long_description"></div>

                                        <table class="table">
                                                                                            <tr>
                                                    <th>
                                                        var
                                                    </th>
                                                    <td>
                                                                                                                    
                                                                                                            </td>
                                                </tr>
                                                                                            <tr>
                                                    <th>
                                                        
                                                    </th>
                                                    <td>
                                                                                                            </td>
                                                </tr>
                                                                                    </table>

                                                                                    <h3>Type(s)</h3>
                                            <code>array</code>
                                                                            </div>
                                </div>
                            </div>
                                                    <a id="property__idp"> </a>
                            <div class="element clickable property  private property__idp" data-toggle="collapse" data-target=".property__idp .collapse">
                                <h2>IdP data.</h2>
                                <pre>_idp : array</pre>
                                <div class="labels">
                                                                                                        </div>
                                <div class="row collapse">
                                    <div class="detail-description">
                                        <div class="long_description"></div>

                                        <table class="table">
                                                                                            <tr>
                                                    <th>
                                                        var
                                                    </th>
                                                    <td>
                                                                                                                    
                                                                                                            </td>
                                                </tr>
                                                                                            <tr>
                                                    <th>
                                                        
                                                    </th>
                                                    <td>
                                                                                                            </td>
                                                </tr>
                                                                                    </table>

                                                                                    <h3>Type(s)</h3>
                                            <code>array</code>
                                                                            </div>
                                </div>
                            </div>
                                                    <a id="property__security"> </a>
                            <div class="element clickable property  private property__security" data-toggle="collapse" data-target=".property__security .collapse">
                                <h2>Security Info related to the SP.</h2>
                                <pre>_security : array</pre>
                                <div class="labels">
                                                                                                        </div>
                                <div class="row collapse">
                                    <div class="detail-description">
                                        <div class="long_description"></div>

                                        <table class="table">
                                                                                            <tr>
                                                    <th>
                                                        var
                                                    </th>
                                                    <td>
                                                                                                                    
                                                                                                            </td>
                                                </tr>
                                                                                            <tr>
                                                    <th>
                                                        
                                                    </th>
                                                    <td>
                                                                                                            </td>
                                                </tr>
                                                                                    </table>

                                                                                    <h3>Type(s)</h3>
                                            <code>array</code>
                                                                            </div>
                                </div>
                            </div>
                                                    <a id="property__contacts"> </a>
                            <div class="element clickable property  private property__contacts" data-toggle="collapse" data-target=".property__contacts .collapse">
                                <h2>Setting contacts.</h2>
                                <pre>_contacts : array</pre>
                                <div class="labels">
                                                                                                        </div>
                                <div class="row collapse">
                                    <div class="detail-description">
                                        <div class="long_description"></div>

                                        <table class="table">
                                                                                            <tr>
                                                    <th>
                                                        var
                                                    </th>
                                                    <td>
                                                                                                                    
                                                                                                            </td>
                                                </tr>
                                                                                            <tr>
                                                    <th>
                                                        
                                                    </th>
                                                    <td>
                                                                                                            </td>
                                                </tr>
                                                                                    </table>

                                                                                    <h3>Type(s)</h3>
                                            <code>array</code>
                                                                            </div>
                                </div>
                            </div>
                                                    <a id="property__organization"> </a>
                            <div class="element clickable property  private property__organization" data-toggle="collapse" data-target=".property__organization .collapse">
                                <h2>Setting organization.</h2>
                                <pre>_organization : array</pre>
                                <div class="labels">
                                                                                                        </div>
                                <div class="row collapse">
                                    <div class="detail-description">
                                        <div class="long_description"></div>

                                        <table class="table">
                                                                                            <tr>
                                                    <th>
                                                        var
                                                    </th>
                                                    <td>
                                                                                                                    
                                                                                                            </td>
                                                </tr>
                                                                                            <tr>
                                                    <th>
                                                        
                                                    </th>
                                                    <td>
                                                                                                            </td>
                                                </tr>
                                                                                    </table>

                                                                                    <h3>Type(s)</h3>
                                            <code>array</code>
                                                                            </div>
                                </div>
                            </div>
                                                    <a id="property__errors"> </a>
                            <div class="element clickable property  private property__errors" data-toggle="collapse" data-target=".property__errors .collapse">
                                <h2>Setting errors.</h2>
                                <pre>_errors : array</pre>
                                <div class="labels">
                                                                                                        </div>
                                <div class="row collapse">
                                    <div class="detail-description">
                                        <div class="long_description"></div>

                                        <table class="table">
                                                                                            <tr>
                                                    <th>
                                                        var
                                                    </th>
                                                    <td>
                                                                                                                    
                                                                                                            </td>
                                                </tr>
                                                                                            <tr>
                                                    <th>
                                                        
                                                    </th>
                                                    <td>
                                                                                                            </td>
                                                </tr>
                                                                                    </table>

                                                                                    <h3>Type(s)</h3>
                                            <code>array</code>
                                                                            </div>
                                </div>
                            </div>
                                                            </div>
            </div>
            <a id="\OneLogin_Saml2_Settings"></a>
            <ul class="breadcrumb">
                <li><a href="../index.html"><i class="icon-custom icon-class"></i></a></li>
                    
    
    <li><span class="divider">\</span><a href="../namespaces/default.html">\</a></li>

                <li class="active"><span class="divider">\</span><a href="../classes/OneLogin_Saml2_Settings.html">OneLogin_Saml2_Settings</a></li>
            </ul>
        </div>
    </div>

    </div>

        <footer class="span12">
            Template is built using <a href="http://twitter.github.com/bootstrap/">Twitter Bootstrap 2</a> and icons provided by
            <a href="http://glyphicons.com/">Glyphicons</a>.<br/>
            Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor </a> and<br/>
            generated on Mon, 14 Apr 2014 20:25:56 +0100.<br/>
    </footer>
    </body>
</html>
